// EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
// The Regents of the University of California, through Lawrence Berkeley National Laboratory
// (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
// National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
// contributors. All rights reserved.
//
// NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
// U.S. Government consequently retains certain rights. As such, the U.S. Government has been
// granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
// worldwide license in the Software to reproduce, distribute copies to the public, prepare
// derivative works, and perform publicly and display publicly, and to permit others to do so.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted
// provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright notice, this list of
//     conditions and the following disclaimer.
//
// (2) Redistributions in binary form must reproduce the above copyright notice, this list of
//     conditions and the following disclaimer in the documentation and/or other materials
//     provided with the distribution.
//
// (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
//     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
//     used to endorse or promote products derived from this software without specific prior
//     written permission.
//
// (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
//     without changes from the version obtained under this License, or (ii) Licensee makes a
//     reference solely to the software portion of its product, Licensee must refer to the
//     software as "EnergyPlus version X" software, where "X" is the version number Licensee
//     obtained under this License and may not use a different name for the software. Except as
//     specifically required in this Section (4), Licensee shall not use in a company name, a
//     product name, in advertising, publicity, or other promotional activities any name, trade
//     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
//     similar designation, without the U.S. Department of Energy's prior written consent.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

#ifndef DataHVACControllers_hh_INCLUDED
#define DataHVACControllers_hh_INCLUDED

// ObjexxFCL Headers
#include <EnergyPlus/Data/BaseData.hh>
#include <ObjexxFCL/Array1D.hh>

// EnergyPlus Headers
#include <EnergyPlus/Data/BaseData.hh>
#include <EnergyPlus/EnergyPlus.hh>

namespace EnergyPlus {

namespace DataHVACControllers {

    int constexpr ControllerSimple_Type(1);

    enum class ControllerAction // Controller action used in modules HVACControllers and ZoneControllers
    {
        Invalid = -1,
        NoAction,
        Reverse,
        NormalAction,
        Num
    };

    enum class ControllerMode // Controller mode used in modules HVACControllers and ZoneControllers
    {
        Invalid = -1, // Controller error. E.g., bad action
        None,         // Controller mode not yet determined
        Off,          // Controller off (no air flow in loop)
        Inactive,     // Controller inactive (equip not available for current step)
        Active,       // Controller active (schedule>0 and min<actuated<max)
        MinActive,    // Controller active and min-constrained (equip available and actuated=min)
        MaxActive,    // Controller active and max-constrained (equip available and actuated=max)
        Num
    };

    int constexpr iFirstMode(static_cast<int>(ControllerMode::Invalid));  // First operating mode in range
    int constexpr iLastMode(static_cast<int>(ControllerMode::MaxActive)); // Last operating mode in range

    enum class ControllerOperation // Controller operation used in module HVACControllers
    {
        Invalid = -1,
        ColdStart,   // Reset for cold start
        WarmRestart, // Reset for warm restart with previous solution
        Iterate,     // Check convergence and estimate next guess if needed
        End,         // Check convergence only and trace
        Num
    };

    enum class ControllerWarmRestart // Controller restart flag used in module HVACControllers
    {
        Invalid = -1,
        None,    // Indicates that warm restart was not attempted
        Fail,    // Indicates that warm restart failed
        Success, // Indicates that warm restart was successful
        Num
    };

} // namespace DataHVACControllers

struct HVACCtrlData : BaseGlobalStruct
{
    Array1D_string const ControllerTypes = Array1D_string(1, std::string("Controller:WaterCoil"));
    static constexpr std::array<std::string_view, 5> ActionTypes = {"No action", "Reverse action", "Normal action"};
    Array1D_string const ControllerModeTypes = Array1D_string({-1, 5},
                                                              {"Wrong action mode",
                                                               "No controller mode",
                                                               "Off controller mode",
                                                               "Inactive controller mode",
                                                               "Active unconstrained controller mode",
                                                               "Active min-constrained controller mode",
                                                               "Active max-constrained controller mode"});

    void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
    {
    }

    void init_state([[maybe_unused]] EnergyPlusData &state) override
    {
    }

    void clear_state() override
    {
        // nothing to clear, it's all constant
    }
};

} // namespace EnergyPlus

#endif
